/*
 * Fichier: Exercice.java
 * Crée le: 07 mai 2007.
 * Modifié: 14 février 2009.
 * Auteurs: Sébastien ESTIENNE.
 * SiteWeb: http://www.prog-info.org/
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

package javaexos.business;



import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import javaexos.model.ChapterModel;
import javaexos.model.ExerciseModel;
import javaexos.model.ExerciseMutableModel;



/**
 * <p>Classe décrivant un exercice.</p>
 * @author Sébastien ESTIENNE.
 */
public class Exercise implements ExerciseMutableModel
{
   /** Numéro de l'exercice. */
   private int number;

   /** Titre de l'exercice. */
   private String title;

   /** Nom de l'exercice. */
   private String name;

   /** Type de l'exercice. */
   private ExoType exoType;

   /** Enoncé de l'exercice. */
   private String declaration;

   /** Nom des images de l'exercice. */
   private List<String> images;

   /** Nom complet des fichiers sources de l'exercice. */
   private List<String> files;

   /** Nom complet de la classe principale. */
   private String mainClass;
   
   /** Référence vers le chapitre associé à l'exercice. */
   private ChapterModel chapter;


   /**
    * <p>Constructeur par défaut d'exercice.</p>
    */
   public Exercise()
   {
      // Initialisation.
      this(0, "", "");
   }


   /**
    * <p>Construction de l'exercice.</p>
    * @param number Le numéro de l'exercice.
    * @param title Le titre de l'exercice.
    * @param name Le nom de l'exercice.
    */
   public Exercise(int number, String title, String name)
   {
      // Initialisation.
      setNumber(number);
      setTitle(title);
      setName(name);
      setType(ExoType.JWS);
      setDeclaration("");
      this.images = new ArrayList<String>();
      this.files = new ArrayList<String>();
      setMainClass("");
      setChapter(null);
   }


   /**
    * <p>Renvoie le numéro de l'exercice.</p>
    * @return Retourne le numéro de l'exercice.
    */
   public int getNumber()
   {
      return this.number;
   }


   /**
    * <p>Modifie le numéro de l'exercice.</p>
    * @param number Le nouveau numéro de l'exercice.
    */
   public void setNumber(int number)
   {
      assert (number > 0) : "'number' doit être strictement positif!";

      if(number > 0)
      {
         this.number = number;
      }
   }


   /**
    * <p>Renvoie le titre de l'exercice.</p>
    * @return Retourne le titre de l'exercice.
    */
   public String getTitle()
   {
      return this.title;
   }


   /**
    * <p>Modifie le titre de l'exercice.</p>
    * @param title Le nouveau titre de l'exercice.
    */
   public void setTitle(String title)
   {
      assert (title != null) : "'title' ne doit pas être null!";

      this.title = title;
   }


   /**
    * <p>Renvoie le nom de l'exercice.</p>
    * @return Retourne le nom de l'exercice.
    */
   public String getName()
   {
      return this.name;
   }


   /**
    * <p>Modifie le nom de l'exercice.</p>
    * @param name Le nouveau nom de l'exercice.
    */
   public void setName(String name)
   {
      assert (name != null) : "'name' ne doit pas être null!";

      this.name = name;
   }


   /**
    * <p>Renvoie le type de l'exercice.</p>
    * @return Retourne le type de l'exercice.
    */
   public ExoType getType()
   {
      return this.exoType;
   }


   /**
    * <p>Modifie le type de l'exercice.</p>
    * @param exoType Le nouveau type de l'exercice.
    */
   public void setType(ExoType exoType)
   {
      assert (exoType != null) : "'exoType' ne doit pas être null!";

      this.exoType = exoType;
   }


   /**
    * <p>Renvoie l'énoncé de l'exercice.</p>
    * @return Retourne l'énoncé de l'exercice.
    */
   public String getDeclaration()
   {
      return this.declaration;
   }


   /**
    * <p>Modifie l'énoncé de l'exercice.</p>
    * @param declaration Le nouvel énoncé de l'exercice.
    */
   public void setDeclaration(String declaration)
   {
      assert (declaration != null) : "'declaration' ne doit pas être null!";

      this.declaration = declaration;
   }


   /**
    * <p>Renvoie la liste des fichiers sources de l'exercice.</p>
    * @return Retourne la liste des fichiers sources de l'exercice.
    */
   public List<String> getFiles()
   {
      return Collections.unmodifiableList(this.files);
   }


   /**
    * <p>Modifie la liste des fichiers sources de l'exercice.</p>
    * @param files La nouvelle liste des fichires sources de l'exercice.
    */
   public void setFiles(List<String> files)
   {
      assert (files != null) : "'fichiers' ne doit pas être null!";

      this.files.clear();
      this.files.addAll(files);
   }


   /**
    * <p>Retourne le nom complet de la classe principale.</p>
    * @return Renvoie nom complet de la classe principale.
    */
   public String getMainClass()
   {
      return this.mainClass;
   }


   /**
    * <p>Modifie le nom complet de la classe principale.</p>
    * @param mainClass Le nom complet de la classe principale.
    */
   public void setMainClass(String mainClass)
   {
      this.mainClass = mainClass.replace("/", ".").replace("\\", ".").replace(".java", "");
   }


   /**
    * <p>Renvoie la liste des noms des images de l'exercice.</p>
    * @return Retourne la liste des noms des images de l'exercice.
    */
   public List<String> getImages()
   {
      return Collections.unmodifiableList(this.images);
   }


   /**
    * <p>Modifie la liste des noms des images de l'exercice.</p>
    * @param images La nouvelle liste des noms des images de l'exercice.
    */
   public void setImages(List<String> images)
   {
      assert (images != null) : "'images' ne doit pas être null!";

      this.images.clear();
      this.images.addAll(images);
   }
   
   
   /**
    * <p>Renvoie la référence vers le chapitre associé à l'exercice.</p>
    * @return Retourne la référence vers le chapitre associé à l'exercice.
    */
   public ChapterModel getChapter()
   {
      return this.chapter;
   }
   
   
   /**
    * <p>Modifie la référence vers le chapitre associé à l'exercice.</p>
    * @param chapter La référence vers le chapitre associé à l'exercice.
    */
   public void setChapter(ChapterModel chapter)
   {
      this.chapter = chapter;
   }


   /**
    * <p>Compare deux exercices par rapport à leur numéro.</p>
    * @param exercise L'exercice à comparer.
    * @return Un entier négatif, zéro, ou un entier négatif si cet objet est plus petit que, égal à,
    *         ou plus grand que le numéro de l'exercice spécifié.
    */
   public int compareTo(ExerciseModel exercise)
   {
      if(getNumber() == exercise.getNumber())
      {
         return 0;
      }
      else if(getNumber() > exercise.getNumber())
      {
         return 1;
      }
      else
      {
         return -1;
      }
   }


   /**
    * <p>Retourne une représentation de l'exercice.</p>
    * @return Renvoie une représentation de l'exercice.
    */
   @Override
   public String toString()
   {
      StringBuilder resultat = new StringBuilder();

      resultat.append(this.number).append(" - ").append(this.name);

      return resultat.toString();
   }
}
